import request from "@/utils/request";

const SEMESTER_BASE_URL = "/api/v1/semester";

const SemesterAPI = {
    /** 获取学期信息分页数据 */
    getPage(queryParams?: SemesterPageQuery) {
        return request<any, PageResult<SemesterPageVO[]>>({
            url: `${SEMESTER_BASE_URL}/page`,
            method: "get",
            params: queryParams,
        });
    },
    /**
     * 获取学期信息表单数据
     *
     * @param id 学期信息ID
     * @returns 学期信息表单数据
     */
    getFormData(id: number) {
        return request<any, SemesterForm>({
            url: `${SEMESTER_BASE_URL}/${id}/form`,
            method: "get",
        });
    },

    /**
     *  添加学期信息
     *
     *  @param data 学期信息表单数据
     */
    add(data: SemesterForm) {
        return request({
            url: `${SEMESTER_BASE_URL}`,
            method: "post",
            data: data,
        });
    },

    /**
     * 更新学期信息
     *
     * @param id 学期信息ID
     * @param data 学期信息表单数据
     */
     update(id: number, data: SemesterForm) {
        return request({
            url: `${SEMESTER_BASE_URL}/${id}`,
            method: "put",
            data: data,
        });
    },

    /**
     * 批量删除学期信息，多个以英文逗号(,)分割
     *
     * @param ids 学期信息ID字符串，多个以英文逗号(,)分割
     */
     deleteByIds(ids: string) {
        return request({
            url: `${SEMESTER_BASE_URL}/${ids}`,
            method: "delete",
        });
    }
}

export default SemesterAPI;

/** 学期信息分页查询参数 */
export interface SemesterPageQuery extends PageQuery {
    /** 中文名称（简体） */
    nameZhCn?: string;
}

/** 学期信息表单对象 */
export interface SemesterForm {
    /** 主键ID */
    id?:  number;
    /** 显示顺序 */
    dispOrder?:  number;
    /** 英文名称 */
    nameEnUs?:  string;
    /** 中文名称（简体） */
    nameZhCn?:  string;
    /** 中文名称（繁体） */
    nameZhBig?:  string;
    /** 类型，1表示学期 */
    type?:  number;
    /** 是否免费，1免费 */
    showFree?:  number;
    /** 内容描述 */
    content?:  string;
    /** 状态，1启用 */
    status?:  number;
    /** 图片路径或URL */
    picture?:  string;
}

/** 学期信息分页对象 */
export interface SemesterPageVO {
    /** 主键ID */
    id?: number;
    /** 显示顺序 */
    dispOrder?: number;
    /** 英文名称 */
    nameEnUs?: string;
    /** 中文名称（简体） */
    nameZhCn?: string;
    /** 中文名称（繁体） */
    nameZhBig?: string;
    /** 类型，1表示学期 */
    type?: number;
    /** 是否免费，1免费 */
    showFree?: number;
    /** 内容描述 */
    content?: string;
    /** 状态，1启用 */
    status?: number;
    /** 图片路径或URL */
    picture?: string;
}
